home *** CD-ROM | disk | FTP | other *** search
/ Linux Cubed Series 7: Sunsite / Linux Cubed Series 7 - Sunsite Vol 1.iso / libs / libreadl.0 / libreadl / info / readline.info-1 next >
Encoding:
GNU Info File  |  1995-11-29  |  49.3 KB  |  1,323 lines
  1. This is Info file readline.info, produced by Makeinfo-1.55 from the
  2. input file rlman.texinfo.
  3.  
  4.    This document describes the GNU Readline Library, a utility which
  5. aids in the consistency of user interface across discrete programs that
  6. need to provide a command line interface.
  7.  
  8.    Copyright (C) 1988, 1991 Free Software Foundation, Inc.
  9.  
  10.    Permission is granted to make and distribute verbatim copies of this
  11. manual provided the copyright notice and this permission notice pare
  12. preserved on all copies.
  13.  
  14.    Permission is granted to copy and distribute modified versions of
  15. this manual under the conditions for verbatim copying, provided that
  16. the entire resulting derived work is distributed under the terms of a
  17. permission notice identical to this one.
  18.  
  19.    Permission is granted to copy and distribute translations of this
  20. manual into another language, under the above conditions for modified
  21. versions, except that this permission notice may be stated in a
  22. translation approved by the Foundation.
  23.  
  24. 
  25. File: readline.info,  Node: Top,  Next: Command Line Editing,  Prev: (DIR),  Up: (DIR)
  26.  
  27. GNU Readline Library
  28. ********************
  29.  
  30.    This document describes the GNU Readline Library, a utility which
  31. aids in the consistency of user interface across discrete programs that
  32. need to provide a command line interface.
  33.  
  34. * Menu:
  35.  
  36. * Command Line Editing::       GNU Readline User's Manual.
  37. * Programming with GNU Readline::  GNU Readline Programmer's Manual.
  38. * Concept Index::           Index of concepts described in this manual.
  39. * Function and Variable Index::       Index of externally visible functions
  40.                    and variables.
  41.  
  42. 
  43. File: readline.info,  Node: Command Line Editing,  Next: Programming with GNU Readline,  Prev: Top,  Up: Top
  44.  
  45. Command Line Editing
  46. ********************
  47.  
  48.    This chapter describes the basic features of the GNU command line
  49. editing interface.
  50.  
  51. * Menu:
  52.  
  53. * Introduction and Notation::    Notation used in this text.
  54. * Readline Interaction::    The minimum set of commands for editing a line.
  55. * Readline Init File::        Customizing Readline from a user's view.
  56. * Bindable Readline Commands::    A description of most of the Readline commands
  57.                 available for binding
  58. * Readline vi Mode::        A short description of how to make Readline
  59.                 behave like the vi editor.
  60.  
  61. 
  62. File: readline.info,  Node: Introduction and Notation,  Next: Readline Interaction,  Up: Command Line Editing
  63.  
  64. Introduction to Line Editing
  65. ============================
  66.  
  67.    The following paragraphs describe the notation used to represent
  68. keystrokes.
  69.  
  70.    The text C-k is read as `Control-K' and describes the character
  71. produced when the Control key is depressed and the k key is struck.
  72.  
  73.    The text M-k is read as `Meta-K' and describes the character
  74. produced when the meta key (if you have one) is depressed, and the k
  75. key is struck.  If you do not have a meta key, the identical keystroke
  76. can be generated by typing ESC first, and then typing k.  Either
  77. process is known as "metafying" the k key.
  78.  
  79.    The text M-C-k is read as `Meta-Control-k' and describes the
  80. character produced by "metafying" C-k.
  81.  
  82.    In addition, several keys have their own names.  Specifically, DEL,
  83. ESC, LFD, SPC, RET, and TAB all stand for themselves when seen in this
  84. text, or in an init file (*note Readline Init File::., for more info).
  85.  
  86. 
  87. File: readline.info,  Node: Readline Interaction,  Next: Readline Init File,  Prev: Introduction and Notation,  Up: Command Line Editing
  88.  
  89. Readline Interaction
  90. ====================
  91.  
  92.    Often during an interactive session you type in a long line of text,
  93. only to notice that the first word on the line is misspelled.  The
  94. Readline library gives you a set of commands for manipulating the text
  95. as you type it in, allowing you to just fix your typo, and not forcing
  96. you to retype the majority of the line.  Using these editing commands,
  97. you move the cursor to the place that needs correction, and delete or
  98. insert the text of the corrections.  Then, when you are satisfied with
  99. the line, you simply press RETURN.  You do not have to be at the end of
  100. the line to press RETURN; the entire line is accepted regardless of the
  101. location of the cursor within the line.
  102.  
  103. * Menu:
  104.  
  105. * Readline Bare Essentials::    The least you need to know about Readline.
  106. * Readline Movement Commands::    Moving about the input line.
  107. * Readline Killing Commands::    How to delete text, and how to get it back!
  108. * Readline Arguments::        Giving numeric arguments to commands.
  109.  
  110. 
  111. File: readline.info,  Node: Readline Bare Essentials,  Next: Readline Movement Commands,  Up: Readline Interaction
  112.  
  113. Readline Bare Essentials
  114. ------------------------
  115.  
  116.    In order to enter characters into the line, simply type them.  The
  117. typed character appears where the cursor was, and then the cursor moves
  118. one space to the right.  If you mistype a character, you can use your
  119. erase character to back up and delete the mistyped character.
  120.  
  121.    Sometimes you may miss typing a character that you wanted to type,
  122. and not notice your error until you have typed several other
  123. characters.  In that case, you can type C-b to move the cursor to the
  124. left, and then correct your mistake.  Afterwards, you can move the
  125. cursor to the right with C-f.
  126.  
  127.    When you add text in the middle of a line, you will notice that
  128. characters to the right of the cursor are `pushed over' to make room
  129. for the text that you have inserted.  Likewise, when you delete text
  130. behind the cursor, characters to the right of the cursor are `pulled
  131. back' to fill in the blank space created by the removal of the text.  A
  132. list of the basic bare essentials for editing the text of an input line
  133. follows.
  134.  
  135. C-b
  136.      Move back one character.
  137.  
  138. C-f
  139.      Move forward one character.
  140.  
  141. DEL
  142.      Delete the character to the left of the cursor.
  143.  
  144. C-d
  145.      Delete the character underneath the cursor.
  146.  
  147. Printing characters
  148.      Insert the character into the line at the cursor.
  149.  
  150. C-_
  151.      Undo the last thing that you did.  You can undo all the way back
  152.      to an empty line.
  153.  
  154. 
  155. File: readline.info,  Node: Readline Movement Commands,  Next: Readline Killing Commands,  Prev: Readline Bare Essentials,  Up: Readline Interaction
  156.  
  157. Readline Movement Commands
  158. --------------------------
  159.  
  160.    The above table describes the most basic possible keystrokes that
  161. you need in order to do editing of the input line.  For your
  162. convenience, many other commands have been added in addition to C-b,
  163. C-f, C-d, and DEL.  Here are some commands for moving more rapidly
  164. about the line.
  165.  
  166. C-a
  167.      Move to the start of the line.
  168.  
  169. C-e
  170.      Move to the end of the line.
  171.  
  172. M-f
  173.      Move forward a word.
  174.  
  175. M-b
  176.      Move backward a word.
  177.  
  178. C-l
  179.      Clear the screen, reprinting the current line at the top.
  180.  
  181.    Notice how C-f moves forward a character, while M-f moves forward a
  182. word.  It is a loose convention that control keystrokes operate on
  183. characters while meta keystrokes operate on words.
  184.  
  185. 
  186. File: readline.info,  Node: Readline Killing Commands,  Next: Readline Arguments,  Prev: Readline Movement Commands,  Up: Readline Interaction
  187.  
  188. Readline Killing Commands
  189. -------------------------
  190.  
  191.    "Killing" text means to delete the text from the line, but to save
  192. it away for later use, usually by "yanking" (re-inserting) it back into
  193. the line.  If the description for a command says that it `kills' text,
  194. then you can be sure that you can get the text back in a different (or
  195. the same) place later.
  196.  
  197.    When you use a kill command, the text is saved in a "kill-ring".
  198. Any number of consecutive kills save all of the killed text together, so
  199. that when you yank it back, you get it all.  The kill ring is not line
  200. specific; the text that you killed on a previously typed line is
  201. available to be yanked back later, when you are typing another line.
  202.  
  203.    Here is the list of commands for killing text.
  204.  
  205. C-k
  206.      Kill the text from the current cursor position to the end of the
  207.      line.
  208.  
  209. M-d
  210.      Kill from the cursor to the end of the current word, or if between
  211.      words, to the end of the next word.
  212.  
  213. M-DEL
  214.      Kill from the cursor the start of the previous word, or if between
  215.      words, to the start of the previous word.
  216.  
  217. C-w
  218.      Kill from the cursor to the previous whitespace.  This is
  219.      different than M-DEL because the word boundaries differ.
  220.  
  221.    And, here is how to "yank" the text back into the line.  Yanking
  222. means to copy the most-recently-killed text from the kill buffer.
  223.  
  224. C-y
  225.      Yank the most recently killed text back into the buffer at the
  226.      cursor.
  227.  
  228. M-y
  229.      Rotate the kill-ring, and yank the new top.  You can only do this
  230.      if the prior command is C-y or M-y.
  231.  
  232. 
  233. File: readline.info,  Node: Readline Arguments,  Prev: Readline Killing Commands,  Up: Readline Interaction
  234.  
  235. Readline Arguments
  236. ------------------
  237.  
  238.    You can pass numeric arguments to Readline commands.  Sometimes the
  239. argument acts as a repeat count, other times it is the sign of the
  240. argument that is significant.  If you pass a negative argument to a
  241. command which normally acts in a forward direction, that command will
  242. act in a backward direction.  For example, to kill text back to the
  243. start of the line, you might type M- C-k.
  244.  
  245.    The general way to pass numeric arguments to a command is to type
  246. meta digits before the command.  If the first `digit' you type is a
  247. minus sign (-), then the sign of the argument will be negative.  Once
  248. you have typed one meta digit to get the argument started, you can type
  249. the remainder of the digits, and then the command.  For example, to give
  250. the C-d command an argument of 10, you could type M-1 0 C-d.
  251.  
  252. 
  253. File: readline.info,  Node: Readline Init File,  Next: Bindable Readline Commands,  Prev: Readline Interaction,  Up: Command Line Editing
  254.  
  255. Readline Init File
  256. ==================
  257.  
  258.    Although the Readline library comes with a set of Emacs-like
  259. keybindings installed by default, it is possible that you would like to
  260. use a different set of keybindings.  You can customize programs that
  261. use Readline by putting commands in an "init" file in your home
  262. directory.  The name of this file is taken from the value of the
  263. environment variable `INPUTRC'.  If that variable is unset, the default
  264. is `~/.inputrc'.
  265.  
  266.    When a program which uses the Readline library starts up, the init
  267. file is read, and the key bindings are set.
  268.  
  269.    In addition, the `C-x C-r' command re-reads this init file, thus
  270. incorporating any changes that you might have made to it.
  271.  
  272. * Menu:
  273.  
  274. * Readline Init Syntax::    Syntax for the commands in the inputrc file.
  275. * Conditional Init Constructs::    Conditional key bindings in the inputrc file.
  276.  
  277. 
  278. File: readline.info,  Node: Readline Init Syntax,  Next: Conditional Init Constructs,  Up: Readline Init File
  279.  
  280. Readline Init Syntax
  281. --------------------
  282.  
  283.    There are only a few basic constructs allowed in the Readline init
  284. file.  Blank lines are ignored.  Lines beginning with a # are comments.
  285. Lines beginning with a $ indicate conditional constructs (*note
  286. Conditional Init Constructs::.).  Other lines denote variable settings
  287. and key bindings.
  288.  
  289. Variable Settings
  290.      You can change the state of a few variables in Readline by using
  291.      the `set' command within the init file.  Here is how you would
  292.      specify that you wish to use `vi' line editing commands:
  293.  
  294.           set editing-mode vi
  295.  
  296.      Right now, there are only a few variables which can be set; so
  297.      few, in fact, that we just list them here:
  298.  
  299.     `editing-mode'
  300.           The `editing-mode' variable controls which editing mode you
  301.           are using.  By default, Readline starts up in Emacs editing
  302.           mode, where the keystrokes are most similar to Emacs.  This
  303.           variable can be set to either `emacs' or `vi'.
  304.  
  305.     `horizontal-scroll-mode'
  306.           This variable can be set to either `On' or `Off'.  Setting it
  307.           to `On' means that the text of the lines that you edit will
  308.           scroll horizontally on a single screen line when they are
  309.           longer than the width of the screen, instead of wrapping onto
  310.           a new screen line.  By default, this variable is set to `Off'.
  311.  
  312.     `mark-modified-lines'
  313.           This variable, when set to `On', says to display an asterisk
  314.           (`*') at the start of history lines which have been modified.
  315.           This variable is `off' by default.
  316.  
  317.     `bell-style'
  318.           Controls what happens when Readline wants to ring the
  319.           terminal bell.  If set to `none', Readline never rings the
  320.           bell.  If set to `visible', Readline uses a visible bell if
  321.           one is available.  If set to `audible' (the default),
  322.           Readline attempts to ring the terminal's bell.
  323.  
  324.     `comment-begin'
  325.           The string to insert at the beginning of the line when the
  326.           `vi-comment' command is executed.  The default value is `"#"'.
  327.  
  328.     `meta-flag'
  329.           If set to `on', Readline will enable eight-bit input (it will
  330.           not strip the eighth bit from the characters it reads),
  331.           regardless of what the terminal claims it can support.  The
  332.           default value is `off'.
  333.  
  334.     `convert-meta'
  335.           If set to `on', Readline will convert characters with the
  336.           eigth bit set to an ASCII key sequence by stripping the eigth
  337.           bit and prepending an ESC character, converting them to a
  338.           meta-prefixed key sequence.  The default value is `on'.
  339.  
  340.     `output-meta'
  341.           If set to `on', Readline will display characters with the
  342.           eighth bit set directly rather than as a meta-prefixed escape
  343.           sequence.  The default is `off'.
  344.  
  345.     `completion-query-items'
  346.           The number of possible completions that determines when the
  347.           user is asked whether he wants to see the list of
  348.           possibilities.  If the number of possible completions is
  349.           greater than this value, Readline will ask the user whether
  350.           or not he wishes to view them; otherwise, they are simply
  351.           listed.  The default limit is `100'.
  352.  
  353.     `keymap'
  354.           Sets Readline's idea of the current keymap for key binding
  355.           commands.  Acceptable `keymap' names are `emacs',
  356.           `emacs-standard', `emacs-meta', `emacs-ctlx', `vi', `vi-move',
  357.           `vi-command', and `vi-insert'.  `vi' is equivalent to
  358.           `vi-command'; `emacs' is equivalent to `emacs-standard'.  The
  359.           default value is `emacs'.  The value of the `editing-mode'
  360.           variable also affects the default keymap.
  361.  
  362.     `show-all-if-ambiguous'
  363.           This alters the default behavior of the completion functions.
  364.           If set to `on', words which have more than one possible
  365.           completion cause the matches to be listed immediately instead
  366.           of ringing the bell.  The default value is `off'.
  367.  
  368.     `expand-tilde'
  369.           If set to `on', tilde expansion is performed when Readline
  370.           attempts word completion.  The default is `off'.
  371.  
  372. Key Bindings
  373.      The syntax for controlling key bindings in the init file is
  374.      simple.  First you have to know the name of the command that you
  375.      want to change.  The following pages contain tables of the command
  376.      name, the default keybinding, and a short description of what the
  377.      command does.
  378.  
  379.      Once you know the name of the command, simply place the name of
  380.      the key you wish to bind the command to, a colon, and then the
  381.      name of the command on a line in the init file.  The name of the
  382.      key can be expressed in different ways, depending on which is most
  383.      comfortable for you.
  384.  
  385.     KEYNAME: FUNCTION-NAME or MACRO
  386.           KEYNAME is the name of a key spelled out in English.  For
  387.           example:
  388.                Control-u: universal-argument
  389.                Meta-Rubout: backward-kill-word
  390.                Control-o: ">&output"
  391.  
  392.           In the above example, `C-u' is bound to the function
  393.           `universal-argument', and `C-o' is bound to run the macro
  394.           expressed on the right hand side (that is, to insert the text
  395.           `>&output' into the line).
  396.  
  397.     "KEYSEQ": FUNCTION-NAME or MACRO
  398.           KEYSEQ differs from KEYNAME above in that strings denoting an
  399.           entire key sequence can be specified, by placing the key
  400.           sequence in double quotes.  Some GNU Emacs style key escapes
  401.           can be used, as in the following example, but the special
  402.           character names are not recognized.
  403.  
  404.                "\C-u": universal-argument
  405.                "\C-x\C-r": re-read-init-file
  406.                "\e[11~": "Function Key 1"
  407.  
  408.           In the above example, `C-u' is bound to the function
  409.           `universal-argument' (just as it was in the first example),
  410.           `C-x C-r' is bound to the function `re-read-init-file', and
  411.           `ESC [ 1 1 ~' is bound to insert the text `Function Key 1'.
  412.           The following escape sequences are available when specifying
  413.           key sequences:
  414.  
  415.          ``\C-''
  416.                control prefix
  417.  
  418.          ``\M-''
  419.                meta prefix
  420.  
  421.          ``\e''
  422.                an escape character
  423.  
  424.          ``\\''
  425.                backslash
  426.  
  427.          ``\"''
  428.                "
  429.  
  430.          ``\'''
  431.                '
  432.  
  433.           When entering the text of a macro, single or double quotes
  434.           should be used to indicate a macro definition.  Unquoted text
  435.           is assumed to be a function name.  Backslash will quote any
  436.           character in the macro text, including " and '.  For example,
  437.           the following binding will make `C-x \' insert a single \
  438.           into the line:
  439.                "\C-x\\": "\\"
  440.  
  441. 
  442. File: readline.info,  Node: Conditional Init Constructs,  Prev: Readline Init Syntax,  Up: Readline Init File
  443.  
  444. Conditional Init Constructs
  445. ---------------------------
  446.  
  447.    Readline implements a facility similar in spirit to the conditional
  448. compilation features of the C preprocessor which allows key bindings
  449. and variable settings to be performed as the result of tests.  There
  450. are three parser directives used.
  451.  
  452. `$if'
  453.      The `$if' construct allows bindings to be made based on the
  454.      editing mode, the terminal being used, or the application using
  455.      Readline.  The text of the test extends to the end of the line; no
  456.      characters are required to isolate it.
  457.  
  458.     `mode'
  459.           The `mode=' form of the `$if' directive is used to test
  460.           whether Readline is in `emacs' or `vi' mode.  This may be
  461.           used in conjunction with the `set keymap' command, for
  462.           instance, to set bindings in the `emacs-standard' and
  463.           `emacs-ctlx' keymaps only if Readline is starting out in
  464.           `emacs' mode.
  465.  
  466.     `term'
  467.           The `term=' form may be used to include terminal-specific key
  468.           bindings, perhaps to bind the key sequences output by the
  469.           terminal's function keys.  The word on the right side of the
  470.           `=' is tested against the full name of the terminal and the
  471.           portion of the terminal name before the first `-'.  This
  472.           allows SUN to match both SUN and SUN-CMD, for instance.
  473.  
  474.     `application'
  475.           The APPLICATION construct is used to include
  476.           application-specific settings.  Each program using the
  477.           Readline library sets the APPLICATION NAME, and you can test
  478.           for it.  This could be used to bind key sequences to
  479.           functions useful for a specific program.  For instance, the
  480.           following command adds a key sequence that quotes the current
  481.           or previous word in Bash:
  482.                $if bash
  483.                # Quote the current or previous word
  484.                "\C-xq": "\eb\"\ef\""
  485.                $endif
  486.  
  487. `$endif'
  488.      This command, as you saw in the previous example, terminates an
  489.      `$if' command.
  490.  
  491. `$else'
  492.      Commands in this branch of the `$if' directive are executed if the
  493.      test fails.
  494.  
  495. 
  496. File: readline.info,  Node: Bindable Readline Commands,  Next: Readline vi Mode,  Prev: Readline Init File,  Up: Command Line Editing
  497.  
  498. Bindable Readline Commands
  499. ==========================
  500.  
  501. * Menu:
  502.  
  503. * Commands For Moving::        Moving about the line.
  504. * Commands For History::    Getting at previous lines.
  505. * Commands For Text::        Commands for changing text.
  506. * Commands For Killing::    Commands for killing and yanking.
  507. * Numeric Arguments::        Specifying numeric arguments, repeat counts.
  508. * Commands For Completion::    Getting Readline to do the typing for you.
  509. * Keyboard Macros::        Saving and re-executing typed characters
  510. * Miscellaneous Commands::    Other miscellaneous commands.
  511.  
  512. 
  513. File: readline.info,  Node: Commands For Moving,  Next: Commands For History,  Up: Bindable Readline Commands
  514.  
  515. Commands For Moving
  516. -------------------
  517.  
  518. `beginning-of-line (C-a)'
  519.      Move to the start of the current line.
  520.  
  521. `end-of-line (C-e)'
  522.      Move to the end of the line.
  523.  
  524. `forward-char (C-f)'
  525.      Move forward a character.
  526.  
  527. `backward-char (C-b)'
  528.      Move back a character.
  529.  
  530. `forward-word (M-f)'
  531.      Move forward to the end of the next word.  Words are composed of
  532.      letters and digits.
  533.  
  534. `backward-word (M-b)'
  535.      Move back to the start of this, or the previous, word.  Words are
  536.      composed of letters and digits.
  537.  
  538. `clear-screen (C-l)'
  539.      Clear the screen and redraw the current line, leaving the current
  540.      line at the top of the screen.
  541.  
  542. `redraw-current-line ()'
  543.      Refresh the current line.  By default, this is unbound.
  544.  
  545. 
  546. File: readline.info,  Node: Commands For History,  Next: Commands For Text,  Prev: Commands For Moving,  Up: Bindable Readline Commands
  547.  
  548. Commands For Manipulating The History
  549. -------------------------------------
  550.  
  551. `accept-line (Newline, Return)'
  552.      Accept the line regardless of where the cursor is.  If this line is
  553.      non-empty, add it to the history list.  If this line was a history
  554.      line, then restore the history line to its original state.
  555.  
  556. `previous-history (C-p)'
  557.      Move `up' through the history list.
  558.  
  559. `next-history (C-n)'
  560.      Move `down' through the history list.
  561.  
  562. `beginning-of-history (M-<)'
  563.      Move to the first line in the history.
  564.  
  565. `end-of-history (M->)'
  566.      Move to the end of the input history, i.e., the line you are
  567.      entering.
  568.  
  569. `reverse-search-history (C-r)'
  570.      Search backward starting at the current line and moving `up'
  571.      through the history as necessary.  This is an incremental search.
  572.  
  573. `forward-search-history (C-s)'
  574.      Search forward starting at the current line and moving `down'
  575.      through the the history as necessary.  This is an incremental
  576.      search.
  577.  
  578. `non-incremental-reverse-search-history (M-p)'
  579.      Search backward starting at the current line and moving `up'
  580.      through the history as necessary using a non-incremental search
  581.      for a string supplied by the user.
  582.  
  583. `non-incremental-forward-search-history (M-n)'
  584.      Search forward starting at the current line and moving `down'
  585.      through the the history as necessary using a non-incremental search
  586.      for a string supplied by the user.
  587.  
  588. `history-search-forward ()'
  589.      Search forward through the history for the string of characters
  590.      between the start of the current line and the current point.  This
  591.      is a non-incremental search.  By default, this command is unbound.
  592.  
  593. `history-search-backward ()'
  594.      Search backward through the history for the string of characters
  595.      between the start of the current line and the current point.  This
  596.      is a non-incremental search.  By default, this command is unbound.
  597.  
  598. `yank-nth-arg (M-C-y)'
  599.      Insert the first argument to the previous command (usually the
  600.      second word on the previous line).  With an argument N, insert the
  601.      Nth word from the previous command (the words in the previous
  602.      command begin with word 0).  A negative argument inserts the Nth
  603.      word from the end of the previous command.
  604.  
  605. `yank-last-arg (M-., M-_)'
  606.      Insert last argument to the previous command (the last word on the
  607.      previous line).  With an argument, behave exactly like
  608.      `yank-nth-arg'.
  609.  
  610. 
  611. File: readline.info,  Node: Commands For Text,  Next: Commands For Killing,  Prev: Commands For History,  Up: Bindable Readline Commands
  612.  
  613. Commands For Changing Text
  614. --------------------------
  615.  
  616. `delete-char (C-d)'
  617.      Delete the character under the cursor.  If the cursor is at the
  618.      beginning of the line, there are no characters in the line, and
  619.      the last character typed was not C-d, then return EOF.
  620.  
  621. `backward-delete-char (Rubout)'
  622.      Delete the character behind the cursor.  A numeric arg says to kill
  623.      the characters instead of deleting them.
  624.  
  625. `quoted-insert (C-q, C-v)'
  626.      Add the next character that you type to the line verbatim.  This is
  627.      how to insert key sequences like C-q, for example.
  628.  
  629. `tab-insert (M-TAB)'
  630.      Insert a tab character.
  631.  
  632. `self-insert (a, b, A, 1, !, ...)'
  633.      Insert yourself.
  634.  
  635. `transpose-chars (C-t)'
  636.      Drag the character before the cursor forward over the character at
  637.      the cursor, moving the cursor forward as well.  If the insertion
  638.      point is at the end of the line, then this transposes the last two
  639.      characters of the line.  Negative argumentss don't work.
  640.  
  641. `transpose-words (M-t)'
  642.      Drag the word behind the cursor past the word in front of the
  643.      cursor moving the cursor over that word as well.
  644.  
  645. `upcase-word (M-u)'
  646.      Uppercase the current (or following) word.  With a negative
  647.      argument, do the previous word, but do not move the cursor.
  648.  
  649. `downcase-word (M-l)'
  650.      Lowercase the current (or following) word.  With a negative
  651.      argument, do the previous word, but do not move the cursor.
  652.  
  653. `capitalize-word (M-c)'
  654.      Capitalize the current (or following) word.  With a negative
  655.      argument, do the previous word, but do not move the cursor.
  656.  
  657. 
  658. File: readline.info,  Node: Commands For Killing,  Next: Numeric Arguments,  Prev: Commands For Text,  Up: Bindable Readline Commands
  659.  
  660. Killing And Yanking
  661. -------------------
  662.  
  663. `kill-line (C-k)'
  664.      Kill the text from the current cursor position to the end of the
  665.      line.
  666.  
  667. `backward-kill-line (C-x Rubout)'
  668.      Kill backward to the beginning of the line.
  669.  
  670. `unix-line-discard (C-u)'
  671.      Kill backward from the cursor to the beginning of the current line.
  672.      Save the killed text on the kill-ring.
  673.  
  674. `kill-whole-line ()'
  675.      Kill all characters on the current line, no matter where the
  676.      cursor is.  By default, this is unbound.
  677.  
  678. `kill-word (M-d)'
  679.      Kill from the cursor to the end of the current word, or if between
  680.      words, to the end of the next word.  Word boundaries are the same
  681.      as `forward-word'.
  682.  
  683. `backward-kill-word (M-DEL)'
  684.      Kill the word behind the cursor.  Word boundaries are the same as
  685.      `backward-word'.
  686.  
  687. `unix-word-rubout (C-w)'
  688.      Kill the word behind the cursor, using white space as a word
  689.      boundary.  The killed text is saved on the kill-ring.
  690.  
  691. `delete-horizontal-space ()'
  692.      Delete all spaces and tabs around point.  By default, this is
  693.      unbound.
  694.  
  695. `yank (C-y)'
  696.      Yank the top of the kill ring into the buffer at the current
  697.      cursor position.
  698.  
  699. `yank-pop (M-y)'
  700.      Rotate the kill-ring, and yank the new top.  You can only do this
  701.      if the prior command is yank or yank-pop.
  702.  
  703. 
  704. File: readline.info,  Node: Numeric Arguments,  Next: Commands For Completion,  Prev: Commands For Killing,  Up: Bindable Readline Commands
  705.  
  706. Specifying Numeric Arguments
  707. ----------------------------
  708.  
  709. `digit-argument (M-0, M-1, ... M--)'
  710.      Add this digit to the argument already accumulating, or start a new
  711.      argument.  M- starts a negative argument.
  712.  
  713. `universal-argument ()'
  714.      Each time this is executed, the argument count is multiplied by
  715.      four.  The argument count is initially one, so executing this
  716.      function the first time makes the argument count four.  By
  717.      default, this is not bound to a key.
  718.  
  719. 
  720. File: readline.info,  Node: Commands For Completion,  Next: Keyboard Macros,  Prev: Numeric Arguments,  Up: Bindable Readline Commands
  721.  
  722. Letting Readline Type For You
  723. -----------------------------
  724.  
  725. `complete (TAB)'
  726.      Attempt to do completion on the text before the cursor.  This is
  727.      application-specific.  Generally, if you are typing a filename
  728.      argument, you can do filename completion; if you are typing a
  729.      command, you can do command completion, if you are typing in a
  730.      symbol to GDB, you can do symbol name completion, if you are
  731.      typing in a variable to Bash, you can do variable name completion,
  732.      and so on.
  733.  
  734. `possible-completions (M-?)'
  735.      List the possible completions of the text before the cursor.
  736.  
  737. `insert-completions ()'
  738.      Insert all completions of the text before point that would have
  739.      been generated by `possible-completions'.  By default, this is not
  740.      bound to a key.
  741.  
  742. 
  743. File: readline.info,  Node: Keyboard Macros,  Next: Miscellaneous Commands,  Prev: Commands For Completion,  Up: Bindable Readline Commands
  744.  
  745. Keyboard Macros
  746. ---------------
  747.  
  748. `start-kbd-macro (C-x ()'
  749.      Begin saving the characters typed into the current keyboard macro.
  750.  
  751. `end-kbd-macro (C-x ))'
  752.      Stop saving the characters typed into the current keyboard macro
  753.      and save the definition.
  754.  
  755. `call-last-kbd-macro (C-x e)'
  756.      Re-execute the last keyboard macro defined, by making the
  757.      characters in the macro appear as if typed at the keyboard.
  758.  
  759. 
  760. File: readline.info,  Node: Miscellaneous Commands,  Prev: Keyboard Macros,  Up: Bindable Readline Commands
  761.  
  762. Some Miscellaneous Commands
  763. ---------------------------
  764.  
  765. `re-read-init-file (C-x C-r)'
  766.      Read in the contents of your init file, and incorporate any
  767.      bindings or variable assignments found there.
  768.  
  769. `abort (C-g)'
  770.      Abort the current editing command and ring the terminal's bell
  771.      (subject to the setting of `bell-style').
  772.  
  773. `do-uppercase-version (M-a, M-b, ...)'
  774.      Run the command that is bound to the corresoponding uppercase
  775.      character.
  776.  
  777. `prefix-meta (ESC)'
  778.      Make the next character that you type be metafied.  This is for
  779.      people without a meta key.  Typing `ESC f' is equivalent to typing
  780.      `M-f'.
  781.  
  782. `undo (C-_, C-x C-u)'
  783.      Incremental undo, separately remembered for each line.
  784.  
  785. `revert-line (M-r)'
  786.      Undo all changes made to this line.  This is like typing the `undo'
  787.      command enough times to get back to the beginning.
  788.  
  789. `tilde-expand (M-~)'
  790.      Perform tilde expansion on the current word.
  791.  
  792. `dump-functions ()'
  793.      Print all of the functions and their key bindings to the readline
  794.      output stream.  If a numeric argument is supplied, the output is
  795.      formatted in such a way that it can be made part of an INPUTRC
  796.      file.
  797.  
  798. 
  799. File: readline.info,  Node: Readline vi Mode,  Prev: Bindable Readline Commands,  Up: Command Line Editing
  800.  
  801. Readline vi Mode
  802. ================
  803.  
  804.    While the Readline library does not have a full set of `vi' editing
  805. functions, it does contain enough to allow simple editing of the line.
  806. The Readline `vi' mode behaves as specified in the Posix 1003.2
  807. standard.
  808.  
  809.    In order to switch interactively between `Emacs' and `Vi' editing
  810. modes, use the command M-C-j (toggle-editing-mode).  The Readline
  811. default is `emacs' mode.
  812.  
  813.    When you enter a line in `vi' mode, you are already placed in
  814. `insertion' mode, as if you had typed an `i'.  Pressing ESC switches
  815. you into `command' mode, where you can edit the text of the line with
  816. the standard `vi' movement keys, move to previous history lines with
  817. `k', and following lines with `j', and so forth.
  818.  
  819.    This document describes the GNU Readline Library, a utility for
  820. aiding in the consitency of user interface across discrete programs
  821. that need to provide a command line interface.
  822.  
  823.    Copyright (C) 1988, 1994 Free Software Foundation, Inc.
  824.  
  825.    Permission is granted to make and distribute verbatim copies of this
  826. manual provided the copyright notice and this permission notice pare
  827. preserved on all copies.
  828.  
  829.    Permission is granted to copy and distribute modified versions of
  830. this manual under the conditions for verbatim copying, provided that
  831. the entire resulting derived work is distributed under the terms of a
  832. permission notice identical to this one.
  833.  
  834.    Permission is granted to copy and distribute translations of this
  835. manual into another language, under the above conditions for modified
  836. versions, except that this permission notice may be stated in a
  837. translation approved by the Foundation.
  838.  
  839. 
  840. File: readline.info,  Node: Programming with GNU Readline,  Next: Concept Index,  Prev: Command Line Editing,  Up: Top
  841.  
  842. Programming with GNU Readline
  843. *****************************
  844.  
  845.    This chapter describes the interface between the GNU Readline
  846. Library and other programs.  If you are a programmer, and you wish to
  847. include the features found in GNU Readline such as completion, line
  848. editing, and interactive history manipulation in your own programs,
  849. this section is for you.
  850.  
  851. * Menu:
  852.  
  853. * Basic Behavior::    Using the default behavior of Readline.
  854. * Custom Functions::    Adding your own functions to Readline.
  855. * Readline Convenience Functions::    Functions which Readline supplies to
  856.                     aid in writing your own
  857. * Custom Completers::    Supplanting or supplementing Readline's
  858.             completion functions.
  859.  
  860. 
  861. File: readline.info,  Node: Basic Behavior,  Next: Custom Functions,  Up: Programming with GNU Readline
  862.  
  863. Basic Behavior
  864. ==============
  865.  
  866.    Many programs provide a command line interface, such as `mail',
  867. `ftp', and `sh'.  For such programs, the default behaviour of Readline
  868. is sufficient.  This section describes how to use Readline in the
  869. simplest way possible, perhaps to replace calls in your code to
  870. `gets()' or `fgets ()'.
  871.  
  872.    The function `readline ()' prints a prompt and then reads and returns
  873. a single line of text from the user.  The line `readline' returns is
  874. allocated with `malloc ()'; you should `free ()' the line when you are
  875. done with it.  The declaration for `readline' in ANSI C is
  876.  
  877.      `char *readline (char *PROMPT);'
  878.  
  879. So, one might say
  880.      `char *line = readline ("Enter a line: ");'
  881.  
  882. in order to read a line of text from the user.  The line returned has
  883. the final newline removed, so only the text remains.
  884.  
  885.    If `readline' encounters an `EOF' while reading the line, and the
  886. line is empty at that point, then `(char *)NULL' is returned.
  887. Otherwise, the line is ended just as if a newline had been typed.
  888.  
  889.    If you want the user to be able to get at the line later, (with C-p
  890. for example), you must call `add_history ()' to save the line away in a
  891. "history" list of such lines.
  892.  
  893.      `add_history (line)';
  894.  
  895. For full details on the GNU History Library, see the associated manual.
  896.  
  897.    It is preferable to avoid saving empty lines on the history list,
  898. since users rarely have a burning need to reuse a blank line.  Here is
  899. a function which usefully replaces the standard `gets ()' library
  900. function, and has the advantage of no static buffer to overflow:
  901.  
  902.      /* A static variable for holding the line. */
  903.      static char *line_read = (char *)NULL;
  904.      
  905.      /* Read a string, and return a pointer to it.  Returns NULL on EOF. */
  906.      char *
  907.      rl_gets ()
  908.      {
  909.        /* If the buffer has already been allocated, return the memory
  910.           to the free pool. */
  911.        if (line_read)
  912.          {
  913.            free (line_read);
  914.            line_read = (char *)NULL;
  915.          }
  916.      
  917.        /* Get a line from the user. */
  918.        line_read = readline ("");
  919.      
  920.        /* If the line has any text in it, save it on the history. */
  921.        if (line_read && *line_read)
  922.          add_history (line_read);
  923.      
  924.        return (line_read);
  925.      }
  926.  
  927.    This function gives the user the default behaviour of TAB
  928. completion: completion on file names.  If you do not want Readline to
  929. complete on filenames, you can change the binding of the TAB key with
  930. `rl_bind_key ()'.
  931.  
  932.      `int rl_bind_key (int KEY, int (*FUNCTION)());'
  933.  
  934.    `rl_bind_key ()' takes two arguments: KEY is the character that you
  935. want to bind, and FUNCTION is the address of the function to call when
  936. KEY is pressed.  Binding TAB to `rl_insert ()' makes TAB insert itself.
  937. `rl_bind_key ()' returns non-zero if KEY is not a valid ASCII character
  938. code (between 0 and 255).
  939.  
  940.    Thus, to disable the default TAB behavior, the following suffices:
  941.      `rl_bind_key ('\t', rl_insert);'
  942.  
  943.    This code should be executed once at the start of your program; you
  944. might write a function called `initialize_readline ()' which performs
  945. this and other desired initializations, such as installing custom
  946. completers (*note Custom Completers::.).
  947.  
  948. 
  949. File: readline.info,  Node: Custom Functions,  Next: Readline Convenience Functions,  Prev: Basic Behavior,  Up: Programming with GNU Readline
  950.  
  951. Custom Functions
  952. ================
  953.  
  954.    Readline provides many functions for manipulating the text of the
  955. line, but it isn't possible to anticipate the needs of all programs.
  956. This section describes the various functions and variables defined
  957. within the Readline library which allow a user program to add
  958. customized functionality to Readline.
  959.  
  960. * Menu:
  961.  
  962. * The Function Type::    C declarations to make code readable.
  963. * Function Writing::    Variables and calling conventions.
  964.  
  965. 
  966. File: readline.info,  Node: The Function Type,  Next: Function Writing,  Up: Custom Functions
  967.  
  968. The Function Type
  969. -----------------
  970.  
  971.    For readabilty, we declare a new type of object, called "Function".
  972. A `Function' is a C function which returns an `int'.  The type
  973. declaration for `Function' is:
  974.  
  975. `typedef int Function ();'
  976.  
  977.    The reason for declaring this new type is to make it easier to write
  978. code describing pointers to C functions.  Let us say we had a variable
  979. called FUNC which was a pointer to a function.  Instead of the classic
  980. C declaration
  981.  
  982.    `int (*)()func;'
  983.  
  984. we may write
  985.  
  986.    `Function *func;'
  987.  
  988. Similarly, there are
  989.  
  990.      typedef void VFunction ();
  991.      typedef char *CPFunction (); and
  992.      typedef char **CPPFunction ();
  993.  
  994. for functions returning no value, `pointer to char', and `pointer to
  995. pointer to char', respectively.
  996.  
  997. 
  998. File: readline.info,  Node: Function Writing,  Prev: The Function Type,  Up: Custom Functions
  999.  
  1000. Writing a New Function
  1001. ----------------------
  1002.  
  1003.    In order to write new functions for Readline, you need to know the
  1004. calling conventions for keyboard-invoked functions, and the names of the
  1005. variables that describe the current state of the line read so far.
  1006.  
  1007.    The calling sequence for a command `foo' looks like
  1008.  
  1009.      `foo (int count, int key)'
  1010.  
  1011. where COUNT is the numeric argument (or 1 if defaulted) and KEY is the
  1012. key that invoked this function.
  1013.  
  1014.    It is completely up to the function as to what should be done with
  1015. the numeric argument.  Some functions use it as a repeat count, some as
  1016. a flag, and others to choose alternate behavior (refreshing the current
  1017. line as opposed to refreshing the screen, for example).  Some choose to
  1018. ignore it.  In general, if a function uses the numeric argument as a
  1019. repeat count, it should be able to do something useful with both
  1020. negative and positive arguments.  At the very least, it should be aware
  1021. that it can be passed a negative argument.
  1022.  
  1023.  - Variable: char * rl_line_buffer
  1024.      This is the line gathered so far.  You are welcome to modify the
  1025.      contents of the line, but see *Note Allowing Undoing::.
  1026.  
  1027.  - Variable: int rl_point
  1028.      The offset of the current cursor position in `rl_line_buffer' (the
  1029.      *point*).
  1030.  
  1031.  - Variable: int rl_end
  1032.      The number of characters present in `rl_line_buffer'.  When
  1033.      `rl_point' is at the end of the line, `rl_point' and `rl_end' are
  1034.      equal.
  1035.  
  1036.  - Variable: int rl_mark
  1037.      The mark (saved position) in the current line.  If set, the mark
  1038.      and point define a *region*.
  1039.  
  1040.  - Variable: int rl_done
  1041.      Setting this to a non-zero value causes Readline to return the
  1042.      current line immediately.
  1043.  
  1044.  - Variable: int rl_pending_input
  1045.      Setting this to a value makes it the next keystroke read.  This is
  1046.      a way to stuff a single character into the input stream.
  1047.  
  1048.  - Variable: char * rl_prompt
  1049.      The prompt Readline uses.  This is set from the argument to
  1050.      `readline ()', and should not be assigned to directly.
  1051.  
  1052.  - Variable: char * rl_terminal_name
  1053.      The terminal type, used for initialization.
  1054.  
  1055.  - Variable: char * rl_readline_name
  1056.      This variable is set to a unique name by each application using
  1057.      Readline.  The value allows conditional parsing of the inputrc file
  1058.      (*note Conditional Init Constructs::.).
  1059.  
  1060.  - Variable: FILE * rl_instream
  1061.      The stdio stream from which Readline reads input.
  1062.  
  1063.  - Variable: FILE * rl_outstream
  1064.      The stdio stream to which Readline performs output.
  1065.  
  1066.  - Variable: Function * rl_startup_hook
  1067.      If non-zero, this is the address of a function to call just before
  1068.      `readline' prints the first prompt.
  1069.  
  1070. 
  1071. File: readline.info,  Node: Readline Convenience Functions,  Next: Custom Completers,  Prev: Custom Functions,  Up: Programming with GNU Readline
  1072.  
  1073. Readline Convenience Functions
  1074. ==============================
  1075.  
  1076. * Menu:
  1077.  
  1078. * Function Naming::    How to give a function you write a name.
  1079. * Keymaps::        Making keymaps.
  1080. * Binding Keys::    Changing Keymaps.
  1081. * Associating Function Names and Bindings::    Translate function names to
  1082.                         key sequences.
  1083. * Allowing Undoing::    How to make your functions undoable.
  1084. * Redisplay::        Functions to control line display.
  1085. * Modifying Text::    Functions to modify `rl_line_buffer'.
  1086. * Utility Functions::    Generally useful functions and hooks.
  1087.  
  1088. 
  1089. File: readline.info,  Node: Function Naming,  Next: Keymaps,  Up: Readline Convenience Functions
  1090.  
  1091. Naming a Function
  1092. -----------------
  1093.  
  1094.    The user can dynamically change the bindings of keys while using
  1095. Readline.  This is done by representing the function with a descriptive
  1096. name.  The user is able to type the descriptive name when referring to
  1097. the function.  Thus, in an init file, one might find
  1098.  
  1099.      Meta-Rubout:    backward-kill-word
  1100.  
  1101.    This binds the keystroke Meta-Rubout to the function *descriptively*
  1102. named `backward-kill-word'.  You, as the programmer, should bind the
  1103. functions you write to descriptive names as well.  Readline provides a
  1104. function for doing that:
  1105.  
  1106.  - Function: int rl_add_defun (char *name, Function *function, int key)
  1107.      Add NAME to the list of named functions.  Make FUNCTION be the
  1108.      function that gets called.  If KEY is not -1, then bind it to
  1109.      FUNCTION using `rl_bind_key ()'.
  1110.  
  1111.    Using this function alone is sufficient for most applications.  It is
  1112. the recommended way to add a few functions to the default functions that
  1113. Readline has built in.  If you need to do something other than adding a
  1114. function to Readline, you may need to use the underlying functions
  1115. described below.
  1116.  
  1117. 
  1118. File: readline.info,  Node: Keymaps,  Next: Binding Keys,  Prev: Function Naming,  Up: Readline Convenience Functions
  1119.  
  1120. Selecting a Keymap
  1121. ------------------
  1122.  
  1123.    Key bindings take place on a "keymap".  The keymap is the
  1124. association between the keys that the user types and the functions that
  1125. get run.  You can make your own keymaps, copy existing keymaps, and tell
  1126. Readline which keymap to use.
  1127.  
  1128.  - Function: Keymap rl_make_bare_keymap ()
  1129.      Returns a new, empty keymap.  The space for the keymap is
  1130.      allocated with `malloc ()'; you should `free ()' it when you are
  1131.      done.
  1132.  
  1133.  - Function: Keymap rl_copy_keymap (Keymap map)
  1134.      Return a new keymap which is a copy of MAP.
  1135.  
  1136.  - Function: Keymap rl_make_keymap ()
  1137.      Return a new keymap with the printing characters bound to
  1138.      rl_insert, the lowercase Meta characters bound to run their
  1139.      equivalents, and the Meta digits bound to produce numeric
  1140.      arguments.
  1141.  
  1142.  - Function: void rl_discard_keymap (Keymap keymap)
  1143.      Free the storage associated with KEYMAP.
  1144.  
  1145.    Readline has several internal keymaps.  These functions allow you to
  1146. change which keymap is active.
  1147.  
  1148.  - Function: Keymap rl_get_keymap ()
  1149.      Returns the currently active keymap.
  1150.  
  1151.  - Function: void rl_set_keymap (Keymap keymap)
  1152.      Makes KEYMAP the currently active keymap.
  1153.  
  1154.  - Function: Keymap rl_get_keymap_by_name (char *name)
  1155.      Return the keymap matching NAME.  NAME is one which would be
  1156.      supplied in a `set keymap' inputrc line (*note Readline Init
  1157.      File::.).
  1158.  
  1159. 
  1160. File: readline.info,  Node: Binding Keys,  Next: Associating Function Names and Bindings,  Prev: Keymaps,  Up: Readline Convenience Functions
  1161.  
  1162. Binding Keys
  1163. ------------
  1164.  
  1165.    You associate keys with functions through the keymap.  Readline has
  1166. several internal keymaps: `emacs_standard_keymap', `emacs_meta_keymap',
  1167. `emacs_ctlx_keymap', `vi_movement_keymap', and `vi_insertion_keymap'.
  1168. `emacs_standard_keymap' is the default, and the examples in this manual
  1169. assume that.
  1170.  
  1171.    These functions manage key bindings.
  1172.  
  1173.  - Function: int rl_bind_key (int key, Function *function)
  1174.      Binds KEY to FUNCTION in the currently active keymap.  Returns
  1175.      non-zero in the case of an invalid KEY.
  1176.  
  1177.  - Function: int rl_bind_key_in_map (int key, Function *function,
  1178.           Keymap map)
  1179.      Bind KEY to FUNCTION in MAP.  Returns non-zero in the case of an
  1180.      invalid KEY.
  1181.  
  1182.  - Function: int rl_unbind_key (int key)
  1183.      Bind KEY to the null function in the currently active keymap.
  1184.      Returns non-zero in case of error.
  1185.  
  1186.  - Function: int rl_unbind_key_in_map (int key, Keymap map)
  1187.      Bind KEY to the null function in MAP.  Returns non-zero in case of
  1188.      error.
  1189.  
  1190.  - Function: int rl_generic_bind (int type, char *keyseq, char *data,
  1191.           Keymap map)
  1192.      Bind the key sequence represented by the string KEYSEQ to the
  1193.      arbitrary pointer DATA.  TYPE says what kind of data is pointed to
  1194.      by DATA; this can be a function (`ISFUNC'), a macro (`ISMACR'), or
  1195.      a keymap (`ISKMAP').  This makes new keymaps as necessary.  The
  1196.      initial keymap in which to do bindings is MAP.
  1197.  
  1198.  - Function: int rl_parse_and_bind (char *line)
  1199.      Parse LINE as if it had been read from the `inputrc' file and
  1200.      perform any key bindings and variable assignments found (*note
  1201.      Readline Init File::.).
  1202.  
  1203. 
  1204. File: readline.info,  Node: Associating Function Names and Bindings,  Next: Allowing Undoing,  Prev: Binding Keys,  Up: Readline Convenience Functions
  1205.  
  1206. Associating Function Names and Bindings
  1207. ---------------------------------------
  1208.  
  1209.    These functions allow you to find out what keys invoke named
  1210. functions and the functions invoked by a particular key sequence.
  1211.  
  1212.  - Function: Function * rl_named_function (char *name)
  1213.      Return the function with name NAME.
  1214.  
  1215.  - Function: Function * rl_function_of_keyseq (char *keyseq, Keymap
  1216.           map, int *type)
  1217.      Return the function invoked by KEYSEQ in keymap MAP.  If MAP is
  1218.      NULL, the current keymap is used.  If TYPE is not NULL, the type
  1219.      of the object is returned in it (one of `ISFUNC', `ISKMAP', or
  1220.      `ISMACR').
  1221.  
  1222.  - Function: char ** rl_invoking_keyseqs (Function *function)
  1223.      Return an array of strings representing the key sequences used to
  1224.      invoke FUNCTION in the current keymap.
  1225.  
  1226.  - Function: char ** rl_invoking_keyseqs_in_map (Function *function,
  1227.           Keymap map)
  1228.      Return an array of strings representing the key sequences used to
  1229.      invoke FUNCTION in the keymap MAP.
  1230.  
  1231. 
  1232. File: readline.info,  Node: Allowing Undoing,  Next: Redisplay,  Prev: Associating Function Names and Bindings,  Up: Readline Convenience Functions
  1233.  
  1234. Allowing Undoing
  1235. ----------------
  1236.  
  1237.    Supporting the undo command is a painless thing, and makes your
  1238. functions much more useful.  It is certainly easy to try something if
  1239. you know you can undo it.  I could use an undo function for the stock
  1240. market.
  1241.  
  1242.    If your function simply inserts text once, or deletes text once, and
  1243. uses `rl_insert_text ()' or `rl_delete_text ()' to do it, then undoing
  1244. is already done for you automatically.
  1245.  
  1246.    If you do multiple insertions or multiple deletions, or any
  1247. combination of these operations, you should group them together into
  1248. one operation.  This is done with `rl_begin_undo_group ()' and
  1249. `rl_end_undo_group ()'.
  1250.  
  1251.    The types of events that can be undone are:
  1252.  
  1253.      enum undo_code { UNDO_DELETE, UNDO_INSERT, UNDO_BEGIN, UNDO_END };
  1254.  
  1255.    Notice that `UNDO_DELETE' means to insert some text, and
  1256. `UNDO_INSERT' means to delete some text.  That is, the undo code tells
  1257. undo what to undo, not how to undo it.  `UNDO_BEGIN' and `UNDO_END' are
  1258. tags added by `rl_begin_undo_group ()' and `rl_end_undo_group ()'.
  1259.  
  1260.  - Function: int rl_begin_undo_group ()
  1261.      Begins saving undo information in a group construct.  The undo
  1262.      information usually comes from calls to `rl_insert_text ()' and
  1263.      `rl_delete_text ()', but could be the result of calls to
  1264.      `rl_add_undo ()'.
  1265.  
  1266.  - Function: int rl_end_undo_group ()
  1267.      Closes the current undo group started with `rl_begin_undo_group
  1268.      ()'.  There should be one call to `rl_end_undo_group ()' for each
  1269.      call to `rl_begin_undo_group ()'.
  1270.  
  1271.  - Function: void rl_add_undo (enum undo_code what, int start, int end,
  1272.           char *text)
  1273.      Remember how to undo an event (according to WHAT).  The affected
  1274.      text runs from START to END, and encompasses TEXT.
  1275.  
  1276.  - Function: void free_undo_list ()
  1277.      Free the existing undo list.
  1278.  
  1279.  - Function: int rl_do_undo ()
  1280.      Undo the first thing on the undo list.  Returns `0' if there was
  1281.      nothing to undo, non-zero if something was undone.
  1282.  
  1283.    Finally, if you neither insert nor delete text, but directly modify
  1284. the existing text (e.g., change its case), call `rl_modifying ()' once,
  1285. just before you modify the text.  You must supply the indices of the
  1286. text range that you are going to modify.
  1287.  
  1288.  - Function: int rl_modifying (int start, int end)
  1289.      Tell Readline to save the text between START and END as a single
  1290.      undo unit.  It is assumed that you will subsequently modify that
  1291.      text.
  1292.  
  1293. 
  1294. File: readline.info,  Node: Redisplay,  Next: Modifying Text,  Prev: Allowing Undoing,  Up: Readline Convenience Functions
  1295.  
  1296. Redisplay
  1297. ---------
  1298.  
  1299.  - Function: int rl_redisplay ()
  1300.      Change what's displayed on the screen to reflect the current
  1301.      contents of `rl_line_buffer'.
  1302.  
  1303.  - Function: int rl_forced_update_display ()
  1304.      Force the line to be updated and redisplayed, whether or not
  1305.      Readline thinks the screen display is correct.
  1306.  
  1307.  - Function: int rl_on_new_line ()
  1308.      Tell the update routines that we have moved onto a new (empty)
  1309.      line, usually after ouputting a newline.
  1310.  
  1311.  - Function: int rl_reset_line_state ()
  1312.      Reset the display state to a clean state and redisplay the current
  1313.      line starting on a new line.
  1314.  
  1315.  - Function: int rl_message (va_alist)
  1316.      The arguments are a string as would be supplied to `printf'.  The
  1317.      resulting string is displayed in the "echo area".  The echo area
  1318.      is also used to display numeric arguments and search strings.
  1319.  
  1320.  - Function: int rl_clear_message ()
  1321.      Clear the message in the echo area.
  1322.  
  1323.